home *** CD-ROM | disk | FTP | other *** search
/ The CICA Windows Explosion! / The CICA Windows Explosion! - Disc 2.iso / programr / xraysql.zip / INSTALL.TXT < prev    next >
Text File  |  1994-11-12  |  13KB  |  388 lines
  1.                          X - R a y / S Q L   S e r v e r
  2.  
  3.  
  4. Installation
  5. ===============================================================================
  6.  
  7. Create a directory for X-Ray/SQL Server, i.e. C:\XRAY. Copy all     
  8. the files contained in this ZIP file to that directory. To run the X-Ray     
  9. demonstration, select "Run..." from the "File" menu of the Program    
  10. Manager and type:
  11.  
  12.     C:\XRAY\XRAYSQL
  13.     
  14. Press Ok or <ENTER> to start X-Ray/SQL Server
  15.  
  16.  
  17. Getting Started
  18. ===============================================================================
  19.  
  20. X-Ray/SQL Server traces function calls of the SQL Server DB-Library interface
  21. for Microsoft Windows.
  22.  
  23. The first time you run X-Ray/SQL Server, follow the procedures below:
  24.  
  25.    1.     In the Help menu, select View README.WRI....
  26.      This command provides information that has become available since the
  27.      manual was printed, and other vital information.
  28.      
  29.    2.     Select Options... (Trace menu) to set your trace preferences..
  30.      Alternatively, press Ctrl + O, or select the Trace icon in the tool
  31.      bar. See "Setting Your Trace Preferences" below for more information.
  32.      
  33.    3.     Select Filters... (Trace menu) to set trace functions and tasks.
  34.      Alternatively, press Ctrl + F, or select the Filters icon in the tool
  35.      bar. See "Selecting Filters" below for more information.
  36.      
  37. Once the menu bar is displayed, you can access help on any menu item by
  38. highlighting it and pressing F1.
  39.  
  40. To access help from the X-Ray/SQL Server window, press F1.
  41.  
  42. This program is limited to storing up to 30 most recent trace 
  43. records. The monochrome, file, and printer log options in the Options dialog 
  44. box will also be disabled. The SQL Server help facility is disabled. Other-
  45. wise all other features are fully functional.
  46.  
  47. Note: This demonstration does not require W3DBLIB.DLL on the     
  48. system in order to execute. However, it won't be much of a demon-     
  49. stration!
  50.  
  51. If you like this product, you may be interested in our other new products:
  52.  
  53.     X-Ray/ODBC tm
  54.     X-Ray/WINSOCK tm
  55.     X-Ray/WLIBSOCK tm
  56.  
  57. Call us at (818) 346-2784 for more details!
  58.  
  59.  
  60. Setting Your Trace Preferences
  61. ===============================================================================
  62.  
  63. Select Options... (Trace menu) to access the Trace Options dialog box and
  64. set your trace preferences.
  65.  
  66. Alternatively, press Ctrl + O, or select the Trace icon  in the tool bar.
  67.  
  68.  
  69. Setting Output Options
  70.  
  71. Trace log    Displays trace information to
  72. only         a window.
  73.              
  74. Monochrome   For a monochrome monitor.
  75. Display      This option is grayed if you
  76.              do not have a monochrome video
  77.              card installed in your
  78.              computer.
  79.              
  80. Printer      Outputs trace information to
  81.              your printer.
  82.              
  83. DBWin        Outputs trace information to
  84.              DBWin (a sample debugger
  85.              available with Microsoft
  86.              Windows SDK and Microsoft
  87.              C/C++ (Visual C++TM)).  This
  88.              option also supports output to
  89.              WinScopeTM by Periscope.  X-
  90.              Ray is compatible with any
  91.              program capable of displaying
  92.              messages sent by the function
  93.              OutputDebugString( ).
  94.              
  95.              Be aware that this option can
  96.              slow your system down if many
  97.              trace events are being logged.
  98.              
  99. File         Outputs trace information to a
  100.              log file.  The default log
  101.              file is C:\SQLSRVR.LOG.
  102.              However, you can enter another
  103.              file in the Log File text box,
  104.              or choose another log file by
  105.              selecting the Browse button.
  106.              
  107.              The default is Append to
  108.              existing file, which appends
  109.              new trace information to the
  110.              log file you specify.  If you
  111.              deselect the default, the log
  112.              file is deleted and a new file
  113.              is created when you run a
  114.              trace on another function.
  115.              
  116. Log          Select this option if you want
  117. Exception    to log Winsock functions that
  118. s only       return errors only.
  119.              
  120. Level of     Select High to output
  121. detail       information details to
  122.              printer, DBWin, or the file
  123.              you specified in the option
  124.              above.  Select Low to display
  125.              only two lines of information
  126.              to the Event Details dialog
  127.              box.
  128.           
  129.  
  130. Setting Display Options
  131.  
  132. Minimize     Minimizes the X-RAY/SQL Server
  133. when trace   application window to an
  134. started      icon.
  135.              
  136. Stop trace   Stops the trace when you
  137. when         activate the X-RAY/SQL Server
  138. activated    window.
  139.             
  140.  
  141. Setting the Log File
  142.  
  143. If you selected File in the Output Options field, and if you do not want to
  144. accept the default of C:\SQLSRVR.LOG, enter the name of the file to which
  145. you want trace information stored, or choose another log file by selecting
  146. the Browse button.
  147.  
  148.  
  149. Setting Buffer Options
  150.  
  151. The number in parentheses below the Buffer Size option is the amount of
  152. memory in kilobytes.
  153.  
  154. Buffer        Enter the number of records,
  155. Size          between 25 to 2000 inclusive,
  156.               that you want to buffer.
  157.               
  158. Circular      When the number of records is
  159.               one more than the number you
  160.               specified in the Buffer Size
  161.               option, the buffer drops the
  162.               oldest record, giving the
  163.               appearance of an endless
  164.               buffer.  The larger the buffer
  165.               size, the more records it can
  166.               hold before losing the oldest
  167.               record.
  168.               
  169. Stop when     The buffer stops accepting
  170. filled        record when the number of
  171.               records you specified in the
  172.               Buffer Size option is reached.
  173.               The trace is automatically
  174.               stopped.
  175.           
  176.  
  177. Setting Your Preferences and Exiting the Dialog Box
  178.  
  179. Select the Ok button, or press Enter to set your preferences and exit the
  180. dialog box.
  181.  
  182.  
  183.  
  184. Selecting Filters
  185. ===============================================================================
  186.  
  187. Select Filters... (Trace menu) to access the Filters dialog box and set
  188. filters.
  189.  
  190. Alternatively, press Ctrl + F, or select the Filters icon in the tool bar.
  191.  
  192.  
  193. Selecting Trace Functions
  194.  
  195. Select the trace functions you want to run in the API Functions list box.
  196.  
  197. To select all functions in the list box, select the Select All button.  To
  198. cancel the functions you selected, select the Clear button.
  199.  
  200. For more information about these functions, refer to the documentation that
  201. accompanies the DB-Library API.
  202.  
  203.  
  204. Selecting Tasks
  205.  
  206. Select the applications for which you want trace information in the Active
  207. Application(s) list box.
  208.  
  209. To select all tasks in the list box, select the Select All button.  To
  210. cancel the tasks you selected, select the Clear button.
  211.  
  212. Select Launch specified application if you want to run a trace on an
  213. application that is not displayed in the Active application(s) list box.
  214. To select the application, select the Choose application... button or enter
  215. the command line of the application.
  216.  
  217.  
  218. Exiting the Dialog Box
  219.  
  220. To exit the dialog box without setting any filters, select the Cancel
  221. button.
  222.  
  223. To set your filters and exit the dialog box, select the Ok button or press
  224. Enter.
  225.  
  226.  
  227. Running Traces
  228. ===============================================================================
  229.  
  230.  
  231. Once you have set your trace preferences and filters, you can run traces.
  232. This section discusses the following:
  233.  
  234.      Starting a trace
  235.      
  236.      Stopping a trace
  237.      
  238.      Viewing trace event details
  239.      
  240.      Continuing a trace
  241.      
  242.      Clearing the trace log and buffer
  243.      
  244.  
  245.  
  246. Starting a Trace
  247.  
  248. Select Start (Trace menu), or press Ctrl + S, or select the Start icon  in
  249. the tool bar to start the trace.
  250.  
  251.  
  252.  
  253. Stopping a Trace
  254.  
  255. Select Pause (Trace menu), or press Ctrl + A, or select the Stop icon  to
  256. pause tracing.
  257.  
  258. Alternatively, If you selected the Stop trace when activated option in the
  259. Trace Options dialog box, tracing will stop when you activate X-
  260. Ray/Winsock.
  261.  
  262.  
  263.  
  264. Viewing Trace Event Details
  265. ===============================================================================
  266.  
  267. Select Event Details... (Trace menu) to access the Event Details dialog box
  268. and view details of trace events.
  269.  
  270. Alternatively, double click on a trace record in the X-Ray/Winsock window,
  271. or press Ctrl + E, or select the Details icon in the tool bar.
  272.  
  273. The Event Details dialog box can remain on the screen as long as the trace
  274. buffer is not cleared (by selecting the Clear icon or selecting Reset
  275. Events (Trace menu).
  276.  
  277.  
  278. Using the Event Details Dialog Box
  279.  
  280. Detail       This window displays detail of
  281. List Box     a specified trace.  You can
  282.              specify the trace for which you
  283.              want more detail by double
  284.              clicking on a trace record in
  285.              the X-Ray window, or by
  286.              entering a number in the Record
  287.              text box and pressing the Get
  288.              button.  Alternatively, you can
  289.              scroll through the list box or
  290.              select the Animate button to
  291.              view other records.
  292.              
  293.              The following information is
  294.              displayed for every trace
  295.              detail:
  296.              
  297.              FUNCTION SUMMARY:  A summary of
  298.              the function, including record
  299.              number, function, and the time
  300.              it was called.
  301.              
  302.              PARAMETERS BEFORE CALL:
  303.              Parameters in the code before
  304.              the function is executed.
  305.              
  306.              RETURNS:  Error codes or values
  307.              that are returned by Winsock.
  308.              
  309.              PARAMETERS AFTER CALL:  Values
  310.              that may have been changed by
  311.              Winsock.
  312.              
  313. Close        Select this button to close the
  314. Button       dialog box.
  315.              
  316. Help         Select this button for help on
  317. Button       the dialog box.
  318.              
  319. Start        Select this button if you want
  320. Button       to automate scrolling through
  321.              the detail list box.  To set
  322.              the animation delay, enter the
  323.              number of seconds delay in the
  324.              seconds text box.
  325.              
  326. Speed        Enter the number from 1 to 15.
  327.              The higher the number, the
  328.              slower the animation (that is,
  329.              auto- mated scrolling through
  330.              the detail list box).  The
  331.              range of values equates to .2
  332.              through 3 seconds. You can
  333.              initiate animation by selecting
  334.              the Animate key.
  335.              
  336. Errors       Select this option if you want
  337. Only         to view error messages while
  338.              animation is enabled.
  339.              
  340. Backwards    Select this option if you want
  341.              to animate backwards.
  342.              
  343. Find         Select this button to find a
  344. Button       record.  The Find dialog box is
  345.              displayed.
  346.              
  347.              You can search by any numeric
  348.              or alphabetic characters.  If
  349.              you search alphabetically, you
  350.              can do a case-sensitive search
  351.              (if the word for which you are
  352.              searching contains capital
  353.              letters) by selecting the Match
  354.              Case option.  You can also
  355.              search up or down through
  356.              records.
  357.              
  358. Get          Select this button to retrieve
  359. Button       details for a trace you specify
  360.              in the Record text box.  The
  361.              record is the first field that
  362.              is displayed in the X-
  363.              Ray/Winsock window.  You can
  364.              also use the scroll buttons to
  365.              scroll backward and forward
  366.              through record numbers.
  367.              
  368. Errors       Select these scroll buttons to
  369. Scroll       scroll backward and forward
  370. Buttons      through errors.
  371.          
  372.  
  373.  
  374. Continuing a Trace
  375.  
  376. Select Continue (Trace menu) after you have stopped/paused the trace to
  377. save the current trace and continue tracing events.
  378.  
  379.  
  380. Clearing the Trace Log and Buffer
  381.  
  382. Select Reset Events (Trace menu) or the Clear icon to clear all events from
  383. the trace log and buffer.
  384.  
  385. If you select this command or the Clear icon, and the Event Details dialog
  386. box is displayed, the dialog box will close.
  387.  
  388.